home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / arc / untgz093.zip / UNTGZ.DOC < prev    next >
Text File  |  1996-05-11  |  15KB  |  353 lines
  1.  
  2.  
  3.                    U N T G Z
  4.  
  5.             D e c o m p r e s s i o n   U t i l i t y
  6.  
  7.               Version 0.93 - May 11, 1996
  8.  
  9.  
  10.  
  11. Overview of this documentation:
  12.  
  13.         1. INTRODUCTION - What is UNTGZ ?
  14.         2. HOW TO USE UNTGZ
  15.         3. UNTGZ OUTPUT
  16.         4. OVERWRITE QUERY
  17.         5. HOW DO I CREATE .TGZ ARCHIVES ?
  18.         6. PROBLEMS ?
  19.     7. ERROR / WARNING MESSAGES
  20.         8. TO DO: What further UNTGZ versions will feature
  21.         9. THANKS AND CREDITS TO:
  22.        10. LICENSE
  23.  
  24. 1. INTRODUCTION - What is UNTGZ ?
  25.  
  26.  UNTGZ is a utility that lets you decompress archives created with the UNIX
  27. TAR/GZIP programs under MS-DOS. These archives usually have the extension .TGZ
  28. and are a very common standard for ftp-servers or UNIX-oriented CD-ROMs.
  29. Note that there are also DOS versions of TAR and GZIP, however, if you want to
  30. decompress TGZ archives with these programs, large temporary files will be cre-
  31. ated. The result is that TGZ decompression under MS-DOS used to be very slow.
  32. With UNTGZ, you can decompress these archives in a single step without creating
  33. temporary files, which means it is much faster.
  34. In addition to this, UNTGZ provides a conveniant way to extract uncompressed
  35. TAR files.
  36.  
  37. Another feature of UNTGZ is the filename conversion. If an archive contains
  38. long (UNIX-style) pathnames, these will automatically be converted into the
  39. MS-DOS '8.3' format (not in the Windows NT version, of course).
  40. If the archive contains subdirectories, these will be created automatically.
  41.  
  42. If you are familiar with UNIX: UNTGZ does the same as the 'tar xfz' command.
  43.  
  44. There are several versions of UNTGZ: UNTGZ.EXE, UNTGZ386.EXE and UNTGZ32.EXE.
  45. An OS/2 Version is now also available (UNTGZOS2.EXE) thanks to Nitin Chandra.
  46. UNTGZ is the standard version which runs on any PC-compatible computer, in-
  47. cluding XTs. UNTGZ/386 is smaller and faster, but requires at least a 386SX
  48. to run. If you have a 386/486/pentium computer, I would suggest renaming 
  49. UNTGZ386.EXE to UNTGZ.EXE.
  50. UNTGZ32 is the Windows NT/Windows 95 version. It is a true 32-bit WIN32
  51. application (character mode) and can be run within a Windows NT/95 DOS box.
  52. If you have Windows NT or Windows 95, then I would strongly recommand using
  53. UNTGZ/32bit, as it is _by far_ faster than the DOS version and supports long
  54. filenames.
  55. If you are interested in how UNTGZ works, the source code is also available.
  56.  
  57. 2. HOW TO USE UNTGZ
  58.  
  59.  To decompress an archive, just type 'UNTGZ archive.tgz'. If you wish to 
  60. extract only specific files, you may specify a filename to extract, or a
  61. combination of wildcards. Example: 'UNTGZ archive.tgz *.c'.
  62. (UNTGZ supports UNIX-style wildcards: * ? [a-b] [!a-b] [^a-b])
  63. Wildcards are not case-sensitive.
  64. UNTGZ will also perform a CRC-check while extracting and inform you if the
  65. archive is damaged.
  66.  
  67. To list the contents of an archive without extracting anything, type the 
  68. following: 'UNTGZ -l archive.tgz'. You can also specify wildcards to list
  69. only selected files. Example: 'UNTGZ -l archive.tgz *.exe'.
  70. Either '-' or '/' may be used as switch char. Commandline arguments are
  71. case insensitive. E.g. 'UNTGZ -l test.tgz' is equivalent to 'UNTGZ /L test.tgz'.
  72. Note that listing an archive will also automatically perform a CRC check.
  73.  
  74. 3. UNTGZ OUTPUT
  75.  
  76.  When you decompress an archive, UNTGZ will tell you the date and time of its
  77. creation as well as the platform on which the archive was created. At this time
  78. the following platforms are recognized:
  79.     - MS-DOS
  80.     - OS/2
  81.     - UNIX
  82.     - Windows NT / Win32
  83.     - VAX/VMS
  84.     - Amiga
  85.     - Atari
  86.     - Macintosh
  87.     - PRIMOS
  88.     - TOPS20
  89. If the platform is not recognized, UNTGZ will report 'unknown platform' as well
  90. as the ID number of the platform.
  91. UNTGZ will then show which files are currently decompressed. If filename con-
  92. version is performed, the MS-DOS name will also be displayed. Example:
  93. ' Extracting verylong-name.c to verylong.c'.
  94. You can abort decompression by pressing Ctrl-Break. Note that this may cause
  95. the file which is currently decompressed to be corrupt.
  96.  
  97. 4. OVERWRITE QUERY
  98.  
  99.  If UNTGZ tries to create a file which is already present on the hard disk, it
  100. will show a prompt in the form 'overwrite (Y/N/A/S/R/Q)'. Valid answers are:
  101. Y  (Yes)    : the file will be overwritten.
  102. N  (No)        : the file will not be overwritten.
  103. A  (Always)    : all files will be overwritten - no more queries
  104. S  (Skip)    : no files will be overwritten - no more queries
  105. Q  (Quit)    : abort decompression
  106. R  (Rename)    : prompt for new filename.
  107.           When entering the new filename, type the whole path.
  108.           Remember to use UNIX-style path separators ('/')
  109. Note that you may sometimes get this overwrite-query even when decompressing an
  110. archive to an empty directory. This is due to the conversion of long filenames
  111. to the MS-DOS format. For instance, the file 'verylong-1.name' and the file
  112. 'verylong-2.name' will both be called 'verylong.nam' after converting their
  113. names to the '8.3'-format. You will then get the overwrite-query. So, be care-
  114. full when you get the (Y/N/A/S/R/Q)-query while decompressing long-filename
  115. archives.
  116.  
  117. 5. HOW DO I CREATE .TGZ ARCHIVES ?
  118.  
  119.  To create .TGZ archives, you need two programs: TAR and GZIP. Type:
  120.  
  121. tar cvf archive.tar *.*
  122. gzip archive.tar
  123. ren archive.taz archive.tgz
  124.  
  125. This will compress all files in the current directory and its subdirs into the
  126. archive 'archive.tgz'
  127. Of course, this is complicated and slow. If you want real fast compression,
  128. use the UNIX tar program.
  129. There is also a program called X1 that can create .TGZ archives. X1 is
  130. very fast and supports many other archive formats, too - including ZIP, ARJ
  131. LZH, etc. If you're looking for a versatile compression program that can
  132. also create TGZ archives, then get X1.
  133. X1 is job(free)ware and you can get the most recent version from
  134. ftp://ftp.elf.stuba.sk:/pub/pc/pack/x1dos???.zip.
  135. However, X1 uses '\' as path seperator (dos style) and not '/', as other
  136. tar implementations do. This means that X1-created TGZ archives containing
  137. subdirectories are incompatible with the UNIX tar.
  138. UNTGZ can't decompress these archives, either.
  139.  
  140. To the author of X1 (just in case he's reading this):
  141. I have tried to inform you about the path separator problem, but the
  142. e-mail adress in the X1 documentation is obsolete. Please, do contact
  143. me!
  144.  
  145. 6. PROBLEMS ?
  146.  
  147. At the moment, UNTGZ can only decompress files compressed with the 'deflation'
  148. algorithm (GZIP method 8). This is the same algorithm used by PKZIP. Anyway,
  149. decompression of PKZIP-compressed archives is not (yet) implemented.
  150. Expect further versions to have this feature.
  151. UNTGZ cannot decompress archives created by the COMPRESS command. This is due
  152. to licensing restrictions; the LZW algorithm used by COMPRESS is patented by
  153. Unisys.
  154. Archives created using SCO 'PACK' aren't supported, either. Maybe I'll imple-
  155. ment this some day ...
  156.  
  157. When decompressing a broken archive, and you answer 'No' at the query
  158. "untgz: warning - possibly invalid tar archive, skip to next block",
  159. weird things may occur. This may even lead to a crash. Answer N only if you
  160. are 100% sure about what you are doing.
  161. The 'No' is only to allow decompression of archives having a broken checksum
  162. field.
  163.  
  164. 7. ERROR / WARNING MESSAGES
  165.  
  166. untgz: error - can't open archive.tgz
  167.     - the archive name you have specified is invalid (file not found).
  168.     - the archive cannot be opened for another reason (SHARE problem).
  169.  
  170. untgz: error - missing filename
  171.     - you have used the -l option without specifying an archive name.
  172.  
  173. untgz: error - '.' is not a valid filespec.
  174.     - '.' is not usable as a specification of files to extract
  175.  
  176. untgz: decompression engine error - bad compressed data.
  177.         - the archive is severely damaged and cannot be decompressed.
  178.  
  179. untgz: error - unknown archive type.
  180.         - the archive is not a gzip archive or uncompressed TAR archive.
  181.           PKZIP archives are not supported at the moment.
  182.  
  183. untgz: error - unknown compression (0)
  184.         - the gzip archive uses a compression type unknown to UNTGZ.
  185.           Only deflation (method 8) is supported, as gzip 1.2.4 does
  186.           not support other compression methods.
  187.  
  188. untgz: error - multi-volume archives not supported
  189.         - UNTGZ cannot decompress the archive, because it is a multi-
  190.           volume archive.
  191.  
  192. untgz: error - don't know how to handle extended gzip header.
  193.         - extended gzip headers are not supported. I have never seen a
  194.           gzip file with extended header, as they are totally uncommon.
  195.           If anyone needs extended header support anyway, please send mail.
  196.           I will then implement it.
  197.  
  198. untgz: error - unexpected EOF
  199.         - the archive is truncated and cannot be correctly decompressed.
  200.  
  201. untgz: error - file is encrypted.
  202.         - decryption is not supported and probably never will be.
  203.           (Export restrictions?)
  204.  
  205. untgz: internal error - nothing to do.
  206.         - congratulations, you have found a bug in UNTGZ! (I hope you'll
  207.           never see this message). Please report what circumstances have
  208.           caused this message.
  209.  
  210. untgz: error - aborted, file may be corrupt.
  211.         - you have pressed ctrl-break (DOS versions only)
  212.  
  213. untgz: error - unable to create directory
  214.         - the directory cannot be created. The most common reason for
  215.           this problem is that a _file_ already exists having the same
  216.           name as the directory to be created.
  217.  
  218. untgz: error - can't create file, skipping file.txt
  219.         - disk write-protected?
  220.         - disk full?
  221.         - file read-only?
  222.         - SHARE problem?
  223.  
  224. untgz: error - can't write file, disk full?
  225.         - This message is self-explanatory.
  226.  
  227. untgz: warning - possibly invalid tar archive, skip to next block (Y/N/A/Q)
  228.         - The archive is a 'normal' gzip file and does not contain a TAR
  229.           archive, or
  230.         - The TAR archive contains redundand date (between headers).
  231.         - The TAR archive is broken.
  232.         - RECOMMENDED OPERATION: JUST PRESS ENTER.
  233.           If you are sure this is _not_ a TAR archive, then press Q.
  234.           Answering 'Yes' will cause UNTGZ to check if the next block is
  235.           a valid TAR header. Answering 'Always' or pressing Enter will
  236.           cause UNTGZ to search for a valid TAR header.
  237.           Answering 'No' will ignore that the header information is not
  238.           valid and will attempt decompression anyway. (Warning! This may
  239.           even cause a crash!) Answer 'No' only if you know what you are
  240.           doing (e.g. when trying to fix a broken TAR archive).
  241.  
  242. untgz: warning - duplicate directory name
  243.         - the directory UNTGZ tried to create already exists.
  244.  
  245. untgz: warning - broken file(s), crc32 error!
  246.         - CRC error. The decompressed data is invalid.
  247.           UNTGZ uses a slightly different CRC-check than GZIP, so if
  248.           you see this message, the archive _may_ be valid anyway.
  249.         - Due to the GZIP/TAR archive format, it is not possible to say
  250.           in which file the error occured.
  251.  
  252. 8. HOW GOOD IS THE .TGZ ARCHIVE FORMAT?
  253.  
  254. Here's a short comparison between .TGZ and other common archive formats:
  255. I've compressed the Borland CLIB source (C+ASM source) into a single archive.
  256. (C:\BORLANDC\CTRL\CLIB\*.*). If you don't believe the test results, then
  257. TRY THIS AT HOME!
  258.  
  259. Original size: 1.294.460 bytes
  260.  
  261. Packer:            Command:                                Archive size:
  262. ARJ 2.41a       ARJ -jm clib.arj *.*                398.834 bytes
  263. LHA 2.13       LHA a clib.lzh *.*                395.336 bytes
  264. PKZIP 2.04g       PKZIP -ex clib.zip *.*            412.316 bytes
  265. Ultra Compress II  UC2 a clib.uc2                257.932 bytes
  266. TGZ           TAR cvf clib.tar *.*; gzip -9 clib.tar    240.866 bytes
  267. TGZ (X1)       X1 a CLIB.TGZ                234.080 bytes
  268. RAR 2.00 (solid)   RAR a -m5 -s clib.rar            231.564 bytes
  269.  
  270. All archivers, including UC2, were configured to provide maximum compression.
  271. This comparison is not meant to show that other archivers are bad. It should
  272. just show that the .TGZ archive format is quite competitive in terms of
  273. compression performance.
  274.  
  275. 9. TO DO: What further UNTGZ versions will feature
  276.  
  277. - ability to 'ungz' (like gzip -d)
  278. - support for PKZIP-compressed tar archives
  279. - eventually add support for other compression methods (LZH)
  280. - much more
  281.  
  282. 10. THANKS AND CREDITS TO:
  283.  
  284. - Mark Adler:        for putting his INFLATE.C in the public domain.
  285.             INFLATE.C provides the decompression routines
  286.             for UNTGZ.
  287.  
  288. - Nitin Chandra:        OS/2 Version. Compilation of Win32 version.
  289.   nitin@indiagate.com   Useful hints and source modifications.
  290.  
  291. - The authors of UNZIP:    for their wildcard matching routines (MATCH.C)
  292.  
  293. - Mateusz Majer:    for providing moral support and for trying to
  294.             develop a freeware TGZ packer.
  295.  
  296. - Chin-yuan Kuo:        for his very detailed and useful bug report
  297.  
  298. - my girlfried:         for not complaining that I spend so much time
  299.                         programming ;-)
  300.                         
  301. 11. WHERE TO GET THE LATEST VERSION
  302.  
  303. On the world wide web, go to the page
  304. http://members.aol.com/steinbr/untgz/
  305.  
  306. or via ftp:
  307. ftp://members.aol.com/steinbr/untgz/untgz???.zip
  308.  
  309. If this doesn't work, then download it from:
  310. ftp://ftp.elf.stuba.sk/pub/pc/pack/untgz???.zip
  311. There are some mirror sites, too.
  312.  
  313. UNTGZ is also available from the SimTel software archive.
  314. ftp://ftp.coast.net/SimTel/msdos/archiver/untgz???.zip
  315. There are over 60 mirror sites all over the world.
  316.  
  317. UNTGZ is available from The Solutions! BBS. +91-11-6855362, 6965881, 6867674
  318. 24 Hrs, FREE, Over 2 GB Online, IndiaNet, OS/2 newsgroups.
  319.  
  320. 12. LICENSE / CONTACTING THE AUTHOR
  321.  
  322.         This freeware program may be distributed according to 
  323.         the terms of the GNU general public license version 2.
  324.     
  325.     See file 'copying' for details.
  326.  
  327.         ** PLEASE NOTE: ** If you frequently use this program,
  328.         then send e-mail to steinbr@aol.com - a simple message
  329.         like "I'm using your program" will _seriously_ enhance
  330.         the possiblity of updates being made.       Thank you.
  331.  
  332.         Also, if you have any suggestions to make, don't hesi-
  333.         tate to send e-mail.
  334.  
  335.         If you can find a bug in UNTGZ, I URGE YOU to report
  336.         it accompanied my the information I need in order to
  337.         fix it. Thanks a lot.
  338.  
  339.  The author may be contacted via snail-mail:
  340.  
  341.     Tillmann Steinbrecher
  342.     Im Wiesengrund 10
  343.     D-64372 Ober-Ramstadt
  344.     GERMANY
  345.  
  346.  ... or via electronic mail:
  347.     
  348.         steinbr@aol.com
  349.  
  350. Amazing that somebody actually _read_ this doc.
  351.     
  352. All trade marks are property of their respective owners.
  353.